Skip to content

perf: parallelize jsDelivr README fallback probes#2384

Merged
ghostdevv merged 8 commits intonpmx-dev:mainfrom
trivikr:fetch-readme-parallel
Apr 9, 2026
Merged

perf: parallelize jsDelivr README fallback probes#2384
ghostdevv merged 8 commits intonpmx-dev:mainfrom
trivikr:fetch-readme-parallel

Conversation

@trivikr
Copy link
Copy Markdown
Contributor

@trivikr trivikr commented Apr 5, 2026

🔗 Linked issue

N/A

🧭 Context

README fallback probing in server/utils/readme-loaders.ts was strictly sequential. On cache misses, packages with missing or nonstandard README filenames could pay for several failed jsDelivr requests before the loader found the right file or gave up, which made worst-case README render time noticeably slower than necessary.

📚 Description

This changes the jsDelivr README fallback path to reduce that long-tail latency while keeping the fallback behavior conservative.

  • Build a prioritized candidate list that tries the npm registry’s readmeFilename first when it exists.
  • Probe jsDelivr candidates in small parallel batches instead of one-by-one.
  • Preserve existing fallback semantics for missing, nonstandard, and truncated npm READMEs.
  • Add unit coverage for batched probing and candidate prioritization in test/unit/server/utils/readme-loaders.spec.ts.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 5, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
npmx.dev Ready Ready Preview, Comment Apr 9, 2026 3:45pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Apr 9, 2026 3:45pm
npmx-lunaria Ignored Ignored Apr 9, 2026 3:45pm

Request Review

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 5, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The PR updates server/utils/readme-loaders.ts to fetch jsDelivr README candidates in concurrent batches of three (via Promise.all) using a new constant JSDELIVR_README_FETCH_BATCH_SIZE. fetchReadmeFromJsdelivr now returns the first non-empty response from each batch (fetch errors or non-OK responses map to null). A new helper buildReadmeFetchCandidates excludes a provided readmeFilename from standard candidates. resolvePackageReadmeSource is changed to try the explicit readmeFilename first and, if that yields null, fall back to fetching the batched candidate list. Tests were added/expanded to verify batching, selective response.text() invocation, and the new candidate ordering; exported function signatures remain unchanged.

Possibly related PRs

Suggested reviewers

  • ghostdevv
  • danielroe
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description is directly related to the changeset, explaining the performance improvement from sequential to batched-parallel README probing and detailing the specific changes made.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@trivikr
Copy link
Copy Markdown
Contributor Author

trivikr commented Apr 5, 2026

Also updated PR to fetch provided readme before starting the fallback batch in 72bb0b2

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
server/utils/readme-loaders.ts (1)

115-125: Fix typoed inline comments

There are a couple of typos (unsucessful, sometihng) in the inline comments. Quick polish for readability.


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 248c6759-6520-45f8-8aca-2e08376a991a

📥 Commits

Reviewing files that changed from the base of the PR and between 36fced5 and 4e00761.

📒 Files selected for processing (2)
  • server/utils/readme-loaders.ts
  • test/unit/server/utils/readme-loaders.spec.ts
✅ Files skipped from review due to trivial changes (1)
  • test/unit/server/utils/readme-loaders.spec.ts

@ghostdevv ghostdevv added this pull request to the merge queue Apr 9, 2026
Merged via the queue into npmx-dev:main with commit ac83c56 Apr 9, 2026
20 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs review This PR is waiting for a review from a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants